Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

GSoD workplace: Create new WasmEdge plug-in contributor guides in C, C++, and Rust #85

Open
mhmohona opened this issue May 31, 2023 · 4 comments
Labels
enhancement New feature or request

Comments

@mhmohona
Copy link
Contributor

mhmohona commented May 31, 2023

Project Name: Create new WasmEdge plug-in contributor guides in C, C++, and Rust

Description:
This issue serves as a centralized place to track the progress of the WasmEdge plug-in contributor guides project, which is part of the Google Season of Docs (GSoD) program. The objective of this project is to create comprehensive guides for developers who want to contribute to the WasmEdge ecosystem by implementing plug-ins in C, C++, or Rust.

The purpose of this issue is to keep a record of the pull requests (PRs) submitted by me throughout the course of this project. By linking the PRs here, it will be easier to track and review the progress and provide feedback as needed.

Project Details:

Outline

  • Getting Started with WasmEdge Plugins

    • What is a WasmEdge plugin?
    • How can WasmEdge plugins be used?
    • Benefits of using WasmEdge Plug-in System
  • Developing WasmEdge Plugins

    • Requirements for developing a WasmEdge plugin
    • Choosing a programming language
      • C
      • C++
      • Rust
    • Setting up the development environment
    • Creating a WasmEdge plugin project
    • Defining the plugin API
    • Implementing the plugin API
    • Compiling the WasmEdge plugin
  • WasmEdge Plugin API Reference

    • Loading a WasmEdge plugin
    • Registering the plugin API
    • Importing the plugin modules
    • Sample application that uses a WasmEdge plugin
    • Examples of WasmEdge Plug-ins
      • Overview of the WasmEdge Plug-ins
      • WasmEdge-Process Plug-in
      • WASI-Crypto Plug-in
      • WASI-NN Plug-in with OpenVINO backend
      • WASI-NN Plug-in with PyTorch backend
      • WASI-NN Plug-in with TensorFlow-Lite backend
      • WasmEdge-HttpsReq Plug-in
  • Understanding WasmEdge Plugins

    • Best Practices for Developing WasmEdge Plug-ins
      • Security best practices
      • Performance best practices
      • Compatibility best practices
      • Documentation best practices
    • Error handling
      • How to handle errors in WasmEdge plugins
      • Tips for avoiding common error-handling pitfalls
    • Debugging
    • How to debug WasmEdge plugins
    • Tips for using WasmEdge's debugging tools
    • Testing
      • How to test WasmEdge plugins
      • Tips for writing effective WasmEdge unit tests
  • Conclusion

  • Recap of WasmEdge Plug-in System

  • Future Development Roadmap

PRs Submitted:

@mhmohona mhmohona added the enhancement New feature or request label May 31, 2023
@alabulei1 alabulei1 changed the title Create new WasmEdge plug-in contributor guides in C, C++, and Rust GSoD workplace: Create new WasmEdge plug-in contributor guides in C, C++, and Rust Jun 6, 2023
@mhmohona
Copy link
Contributor Author

mhmohona commented Jun 20, 2023

Update until today, 20 June -

Pull Request - #102

Improved existing documentation -

  • Plugin Introduction
  • Loadable Plugin
  • Currently released Plugin

Created new documentation -

  • Developing WasmEdge Plugins
    • Requirements for developing a WasmEdge plugin
    • Choosing a programming language
      • C
      • C++
      • Rust
    • Setting up the development environment
    • Creating a WasmEdge plugin project
    • Defining the plugin API
    • Implementing the plugin API
    • Compiling the WasmEdge plugin

@alabulei1
Copy link
Collaborator

@mhmohona Please update your work progress here. Thanks.

@mhmohona
Copy link
Contributor Author

mhmohona commented Aug 2, 2023

Update till July 31 -

@mhmohona
Copy link
Contributor Author

Update till September -
Worked on following PRs

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants